[]
添加新的数据源。
请求数据格式
AddDataSourceRequestViewModelV2
返回值
状态码: 200
成功
AddDataSourceResponseViewModelV2
状态码: 400
错误的请求
更新数据源。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
id必填项 | string | path | 数据源 ID。例如:15fd3940-e83c-19d7-246d-81b2ccb7e195 |
请求数据格式
UpdateDataSourceRequestViewModelV2
返回值
状态码: 200
成功
UpdateDatasourceResponseViewModelV2
状态码: 400
错误的请求
通过其 ID 和(可选)其版本查询特定数据源的详细信息。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
id必填项 | string | path | 要查询的数据源的唯一标识符。 |
version | int32 | query | 查询的数据源的版本。若未指定,则使用最新版本。 |
返回值
状态码: 200
成功
状态码: 400
错误的请求
下载数据源文档。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
id必填项 | string | path | 文档编号。例如:05bb029e-0d75-dc4d-671b-87299a4a6907 |
返回值
状态码: 200
成功
binary
状态码: 400
错误的请求
状态码: 404
未找到
根据提供的搜索条件分页查询数据源,包括对多租户、用户上下文和提取状态的支持。
请求数据格式
QueryDataSourceWithPaginationModel
返回值
状态码: 200
成功
QueryDataSourcesWithPaginationResponseModel
状态码: 400
错误的请求
通过任务id查询数据源任务状态。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
taskId必填项 | string | path | 任务 ID,前缀为“datasource:”。例如:datasource:a10f7bbc-a416-46e5-ab19-e79e2293a88a |
返回值
状态码: 200
成功
状态码: 400
错误的请求
状态码: 404
未找到
请求数据格式
DataSourceVariableRequestModel
返回值
状态码: 200
成功
DataSourceVariableResponseModel
状态码: 400
错误的请求
检索可用数据源提供者的列表。
返回值
状态码: 200
成功
DataSourceProvidersResponseModel
状态码: 400
错误的请求
查询数据源。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
id必填项 | string | path | 数据源ID |
query | string | query | 查询 |
queryType | string | query | 查询类型 |
format | string | query | 格式 |
UnknownTypeHandle | string | query | 未知类型处理方式 |
MissParameterHandle | string | query | 缺少参数处理方式 |
RowLimit | string | query | 行限制 |
返回值
状态码: 200
成功
binary
状态码: 400
错误的请求
状态码: 404
未找到
查询数据源。
参数:
名称 | 类型 | 位置 | 描述 |
---|---|---|---|
id必填项 | string | path | 数据源ID |
请求数据格式
返回值
状态码: 200
成功
binary
状态码: 400
错误的请求
状态码: 404
未找到
添加数据源的响应。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
id可为空 | string | 数据源标识。 | |
name可为空 | string | 数据源名称。 | |
provider可为空 | string | 数据源提供者。 |
数据集插件错误模型
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
code可为空 | string | 错误代码 | |
message可为空 | string | 错误信息 | |
context可为空 | string | 错误上下文 | |
innerError | DatasetPluginErrorV2 | ||
extendedResult可为空 | any | 扩展结果 |
添加数据源的请求。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
name | string | 数据源名称。 | "Data source name." |
provider | string | 数据源提供者。 | "SqlServer" |
connectionString | string | 连接字符串。 | "Server=host; Database=Database; User ID=sa; Password=Password;" |
useAdvancedConfig | Boolean | 是否使用高级配置连接字符串,若不使用高级配置连接字符串,ConnectionString需要为Server="host";User ID="sa";Password="Password";Database="Database"。 | true |
extractInDatabase | Boolean | 是否将数据提取到数据库中。当 connectionString 包含 SourceType 字段且 SourceType 字段不是“文件系统”时,ExtractInDatabase 需要为 true | |
mappingConfig可为空 | string | 表/字段名称映射。 |
更新数据源的响应。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
id可为空 | string | 数据源标识。 | |
name可为空 | string | 数据源名称。 | |
provider可为空 | string | 数据源提供者。 | |
useAdvancedConfig | Boolean | 是否使用高级配置连接字符串。 | |
connectionString可为空 | string | 连接字符串。 | |
mappingConfigs可为空 | TableMappingInfoViewModelV2 | 表/字段名称映射。 |
表示版本 2 中数据源中的表的映射信息,包括其原始名称和显示名称以及其列映射。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
tableOriginalName可为空 | string | 数据源中定义的表的原始名称。 | |
tableDisplayName可为空 | string | 用于显示目的的表的名称可能比原始名称更用户友好或更具描述性。 | |
columns可为空 | ColumnMappingInfoViewModelV2 | 列映射信息集合,表示数据源中原始列名与其对应的显示名的映射。 |
表示版本 2 中数据源中列的映射信息,包括其原始名称和显示名称。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
columnOriginalName可为空 | string | 数据源中定义的列的原始名称。 | |
columnDisplayName可为空 | string | 用于显示目的的列名称可能比原始名称更用户友好或更具描述性。 |
更新数据源的请求。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
name | string | 数据源名称。 | "Data source name." |
provider | string | 数据源提供者。 | "SqlServer" |
connectionString | string | 连接字符串。 | "Server=host; Database=Database; User ID=sa; Password=Password;" |
useAdvancedConfig | Boolean | 是否使用高级配置连接字符串,若不使用高级配置连接字符串,ConnectionString需要为Server="host";User ID="sa";Password="Password";Database="Database"。 | true |
extractInDatabase | Boolean | 是否将数据提取到数据库中。当 connectionString 包含 SourceType 字段且 SourceType 字段不是“文件系统”时,ExtractInDatabase 需要为 true | |
mappingConfig可为空 | string | 表/字段名称映射。 |
表示具有版本 2 的配置和元数据的数据源实体。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
displayName可为空 | string | 数据源的显示名称。 | |
id可为空 | string | 数据源的唯一标识符。 | |
name可为空 | string | 数据源的名称。 | |
fileName可为空 | string | 与数据源关联的文件名。 | |
provider可为空 | string | 数据源的提供者。 | |
useAdvancedConfig | Boolean | 指示数据源是否使用高级配置。 | |
connectionString可为空 | string | 数据源的连接字符串。 | |
mappingConfigs可为空 | TableMappingInfoViewModelV2 | 数据源内表的映射配置。 | |
useUserContext | Boolean | 指示数据源中是否利用了用户上下文。 | |
useMultiTenant | Boolean | 指示数据源是否支持多租户。 | |
isExtracted | Boolean | 指示数据源是否已被提取。 | |
supportNativeQuery | Boolean | 指示数据源是否支持本机查询。 | |
supportDirectQuery | Boolean | 指示数据源是否支持直接查询。 | |
type可为空 | string | 数据源的类型。 | |
editorConfig可为空 | string | 数据源的编辑器配置。 |
表示检索数据源列表以及分页信息的查询的响应模型。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
data可为空 | DataSourceV2ViewModel | 数据源视图模型列表。每个模型都提供有关特定数据源的详细信息。 | |
pagination | PaginationModel |
表示数据集查询的分页详细信息,包括页面大小、当前页码和项目总数。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
pageSize | int32 | 获取或设置每页的项目数。这决定了每页显示多少个项目。 | |
pageNumber | int32 | 获取或设置当前页码。这用于计算要显示的项目的偏移量。 | |
total | int64 | 获取或设置所有页面的总项目数。这用于计算可用的总页面数。 |
表示使用分页和过滤选项查询数据源的模型。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
pageSize | int32 | 获取或设置分页的页面大小。 | 10 |
pageNumber | int32 | 获取或设置分页的当前页码。 | 1 |
orderBy可为空 | string | 获取或设置对结果进行排序的标准。 | "+name" |
search可为空 | string | 获取或设置用于过滤结果的搜索词。 | "sales" |
useMultiTenant可为空 | Boolean | 获取或设置一个值,指示是否根据多租户过滤结果。 | true |
useUserContext可为空 | Boolean | 获取或设置一个值,指示是否根据用户上下文过滤结果。 | |
isExtracted可为空 | Boolean | 获取或设置一个值,该值指示是否根据数据源是否已被提取来过滤结果。 | true |
providers可为空 | string | 获取或设置要包含在结果中的提供程序。 | "SqlServer,Oracle" |
filterProviders可为空 | string | 获取或设置要从结果中排除的提供程序。 | "MySQL" |
worker 任务状态视图模型。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
taskId可为空 | string | 任务 ID。 | |
status | WorkerTaskStatusEnumV2 | ||
statusText可为空 | string | 任务状态。 | |
startTime可为空 | ISO DateTime Sting | 开始时间。 | |
endTime可为空 | ISO DateTime Sting | 时间结束。 | |
errorMessage可为空 | string | 错误信息。 | |
errorMessageKey可为空 | string | 错误消息键。 | |
context可为空 | string | 上下文。 | |
extraInfo可为空 | string | 额外信息。 |
Enum:
Standby
Running
PrimaryTaskFinished
PrimaryTaskFaulted
PrimaryTaskUserCancelled
Finished
任务状态。
* standby
- 0 - 待机。
* running
- 1 - 正在运行。
* primarytaskfinished
- 2 - 主任务已完成。
* primarytaskfaulted
- 3 - 主任务发生故障。
* primarytaskusercancelled
- 4 - 主任务已被用户取消。
* finished
- 7 - 已完成。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
success | Boolean | ||
variables可为空 | PreRequestVariableViewModel |
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
preRequestName可为空 | string | ||
variableName可为空 | string | ||
variableValue可为空 | string |
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
provider可为空 | string | ||
preRequestName可为空 | string | ||
connectionString可为空 | string |
表示检索数据源提供程序的请求的响应模型,包含数据源类别及其各自提供程序的集合。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
dataSourceProviders可为空 | DataSourceCategoryViewModelV2 | 数据源类别及其各自提供者的集合。 |
表示版本 2 中的数据源提供程序的类别和配置详细信息。
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
name可为空 | string | 数据源提供者的唯一名称标识符。 | |
displayName可为空 | string | 为了演示目的而显示的数据源提供者的名称。 | |
category可为空 | string | 数据源提供程序所属的类别。 | |
editorConfig可为空 | string | JSON 格式的编辑器配置,指定用于配置数据源提供程序的 UI 元素和行为。 | |
unavailable | Boolean | 指示数据源提供程序当前是否不可用。 | |
hasUserGuide | Boolean | 指示数据源提供商是否有可用的用户指南。 |
查询数据源请求体
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
datasourceParameters可为空 | string | 数据源参数 | |
query可为空 | string | 查询 | |
queryType可为空 | string | 查询类型 | |
format可为空 | string | 格式 | |
options | Options |
名称 | 类型 | 描述 | 示例 |
---|---|---|---|
unknownTypeHandle可为空 | string | 未知类型处理方式 | |
missParameterHandle可为空 | string | 缺少参数处理方式 | |
rowLimit可为空 | string | 行限制 |